Current Sens Click Driver

API for configuring and manipulating Current Sens Click driver. More...

Topics
	Current Sens Registers Settings
	Settings for registers of Current Sens Click driver.
	Current Sens MikroBUS Map
	MikroBUS pin mapping of Current Sens Click driver.

Functions
void	currentsens_cfg_setup (currentsens_cfg_t *cfg)
	Current Sens configuration object setup function.
void	currentsens_drv_interface_sel (currentsens_cfg_t *cfg, currentsens_drv_t drv_sel)
	Current Sens driver interface setup function.
err_t	currentsens_init (currentsens_t *ctx, currentsens_cfg_t *cfg)
	Current Sens initialization function.
err_t	currentsens_read_raw_adc (currentsens_t *ctx, uint16_t *raw_adc)
	Current Sens read raw ADC value function.
err_t	currentsens_read_voltage (currentsens_t *ctx, float *voltage)
	Current Sens read voltage level function.
err_t	currentsens_read_voltage_avg (currentsens_t *ctx, uint16_t num_conv, float *voltage_avg)
	Current Sens read average voltage level function.
err_t	currentsens_set_vref (currentsens_t *ctx, float vref)
	Current Sens set vref function.
err_t	currentsens_calib_offset (currentsens_t *ctx)
	Current Sens calib offset function.
err_t	currentsens_calib_resolution (currentsens_t *ctx, float calib_current)
	Current Sens calib resolution function.
err_t	currentsens_read_current (currentsens_t *ctx, float *current)
	Current Sens read current function.

Detailed Description

API for configuring and manipulating Current Sens Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

currentsens_calib_offset()

err_t currentsens_calib_offset

(

currentsens_t *

ctx

)

Current Sens calib offset function.

This function calibrates the zero current offset value.

Parameters

[in]

ctx

: Click context object. See currentsens_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function should only be called when no current flows through the sensor.

currentsens_calib_resolution()

err_t currentsens_calib_resolution	(	currentsens_t *	ctx,
		float	calib_current )

Current Sens calib resolution function.

This function calibrates the data resolution at the known load current.

Parameters

[in]	ctx	: Click context object. See currentsens_t object definition for detailed explanation.
[in]	calib_current	: The known load current used for calibrating data resolution.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function should only be called when a known amount of load current flows through the sensor and after calibrating zero current offset using currentsens_calib_offset function.

currentsens_cfg_setup()

void currentsens_cfg_setup

(

currentsens_cfg_t *

cfg

)

Current Sens configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See currentsens_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

currentsens_drv_interface_sel()

void currentsens_drv_interface_sel	(	currentsens_cfg_t *	cfg,
		currentsens_drv_t	drv_sel )

Current Sens driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters

[out]	cfg	: Click configuration structure. See currentsens_cfg_t object definition for detailed explanation.
[in]	drv_sel	: Driver interface selection. See currentsens_drv_t object definition for detailed explanation.

Returns

Nothing.

Note

This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

currentsens_init()

err_t currentsens_init	(	currentsens_t *	ctx,
		currentsens_cfg_t *	cfg )

Current Sens initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See currentsens_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See currentsens_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

currentsens_read_current()

err_t currentsens_read_current	(	currentsens_t *	ctx,
		float *	current )

Current Sens read current function.

This function reads the input current level [A].

Parameters

[in]	ctx	: Click context object. See currentsens_t object definition for detailed explanation.
[out]	current	: Input current level [A].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

This function relies on calibrated zero current offset and data resolution. Refer to currentsens_calib_offset and currentsens_calib_resolution functions.

currentsens_read_raw_adc()

err_t currentsens_read_raw_adc	(	currentsens_t *	ctx,
		uint16_t *	raw_adc )

Current Sens read raw ADC value function.

This function reads raw ADC value.

Parameters

[in]	ctx	: Click context object. See currentsens_t object definition for detailed explanation.
[out]	raw_adc	: Output ADC result.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

currentsens_read_voltage()

err_t currentsens_read_voltage	(	currentsens_t *	ctx,
		float *	voltage )

Current Sens read voltage level function.

This function reads raw ADC value and converts it to proportional voltage level.

Parameters

[in]	ctx	: Click context object. See currentsens_t object definition for detailed explanation.
[out]	voltage	: Output voltage level [V].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered reference voltage.

currentsens_read_voltage_avg()

err_t currentsens_read_voltage_avg	(	currentsens_t *	ctx,
		uint16_t	num_conv,
		float *	voltage_avg )

Current Sens read average voltage level function.

This function reads a desired number of ADC samples and calculates the average voltage level.

Parameters

[in]	ctx	: Click context object. See currentsens_t object definition for detailed explanation.
[in]	num_conv	: Number of ADC samples.
[out]	voltage_avg	: Average output voltage level [V].

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The conversion to voltage depends on the entered reference voltage.

currentsens_set_vref()

err_t currentsens_set_vref	(	currentsens_t *	ctx,
		float	vref )

Current Sens set vref function.

This function sets the voltage reference for Current Sens Click driver.

Parameters

[in]	ctx	: Click context object. See currentsens_t object definition for detailed explanation.
[in]	vref	: Reference voltage (volts).

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

The default voltage reference set with currentsens_init is 3.3V.